third-party-prc-api icon

third-party-prc-api

(0 reviews)

Get Financial Statement

URLS:

Description : This API will return the Financial statement of a customer by getting customer id as input query parameter. The EXP api will call the backend PRC layer and the process layer will request the PostgreSQL SYS layer with the query and customer id in the input parameter section, SYS layer will call the backend PostgreSQL DB server to get the Financial statement data from table.

Channels can consume Mulesoft’s REST API exposed as an experience API.

Mulesoft Request:

Mandatory Headers: client_id, client_secret, x-channel-id, x-correlation-id, x-bank-id

Optional Headers: Authorization, x-user-id, x-sub-channel-id, x-debug-flag, x-customer-id

URI Parameter

FieldNameDataTypeRequired?LengthsampleDescription
idstringYesMin 2 Max 5012346789Represents unique identifier number of a customer

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field NameTypeOccurrenceDescription
statusObjectMandatory
successBooleanMandatorytrue/false
codeStringMandatory“0” incase of success or Error Code
reasonCodeStringOptionalAdd this tag only incase of error
arabicMessageStringMandatoryin case of success or arabic translated error in case of known errors
englishMessageStringMandatory“The Operation has been Successfully Completed” Or error Description
End of status
responseObjectMandatoryPresent if success = true
financialStatementArrayMandatoryRecurring object inside array
bankIdStringOptional Mandatory
referenceDatedatetimeOptional
customerIdStringMandatory
currencyStringMandatory
exchangeRateStringOptional
exchangeRateIntStringOptional
accountingUnitStringOptional
finstStartDatedatetimeOptional
finstEndDatedatetimeOptional
finstTypedatetimeOptional
finstStructureStringOptional
finstReclDetStringOptional
finstReclTypeStringOptional
finstOffStringOptional
finFieldStringOptional
fieldValueStringOptional

Sample Response

{
    "status": {
        "success": true,
        "code": "200",
        "arabicMessage": "تمت العملية بنجاح",
        "englishMessage": "The Operation has been Successfully Completed"
    },
    "response": {
        "financialStatement": [
            {
                "bankId": "CBOJ",
                "referenceDate": "?",
                "customerId": "2001709",
                "currency": "JOD",
                "exchangeRate": "1.0",
                "exchangeRateInt": "0",
                "accountingUnit": "",
                "finstStartDate": "2018-01-01 T 00:00:00",
                "finstEndDate": "2018-12-31T00:00:00",
                "finstType": "I",
                "finstStructure": "1",
                "finstReclDet": "",
                "finstReclType": 1,
                "finstOff": "5",
                "finField": "Accts/Notes Rec-Trade",
                "fieldValue": "1161.0"
            },
            {
                "bankId": "CBOJ",
                "referenceDate": "?",
                "customerId": "2001709",
                "currency": "JOD",
                "exchangeRate": "1.0",
                "exchangeRateInt": "0",
                "accountingUnit": "",
                "finstStartDate": "2018-01-01 T 00:00:00",
                "finstEndDate": "2018-12-31T00:00:00",
                "finstType": "I",
                "finstStructure": "1",
                "finstReclDet": "",
                "finstReclType": 1,
                "finstOff": "5",
                "finField": "AccruedLiabs+OtherCurLiabs",
                "fieldValue": "1081"
            }
     ]
    }
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
    "status": {
        "success": false,
        "code": "400",
        "reasonCode": "BadRequest",
        "arabicMessage": "",
        "englishMessage": "No records were found that matched the selection criteria",
        "backendError": "",
        "backendCode": ""
    }
}

Reviews